CRPEJob::GetNthGroupSortField

Syntax

GetNthGroupSortField (sortFieldN SMALLINT) RETURNING BOOLEAN, ixString, SMALLINT

Parameter

sortFieldN

Specifies the 0-based number of the group sort field you want to retrieve. The first group sort field is field 0. If the report has N sort fields, the function can be called with sortFieldN between 0 and N-1.

Remarks

Returns information about one of the group sort fields in the specified report: that is, it returns the name of the field and the direction (ascending or descending) of the sort. This method is typically used as one of a series: CRPEJob::GetNGroupSortFields (called once), CRPEJob::GetNthGroupSortField (called as many times as needed to identify the correct group sort field), and CRPEJob::SetNthGroupSortField (called once when the correct sort field is identified). The series can be used to identify and then change an existing group sort field and/or sort order at print time in response to a user selection.

Returns

BOOLEAN

TRUE if the call is successful, FALSE if something goes wrong.

ixString

Retrieves the name of the group sort field.

SMALLINT

Retrieves one of the Sort Order Constants.

Related Topics

PEGetNthGroupSortField



Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com